-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS-11542] Java servlet-based web apps RUM #30869
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good. Not an RUM eng but it's very similar to the manual I wrote for the customer preview.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, Rosa! For the content, I just have some minor suggestions and things I want to double-check 🙂
While I was clicking around on the page, I noticed that if I switched to another tab and tried to click back to Java, the tab wouldn't load. You can see that it assumed that the end of the URL was java
instead of java_servlet
:
I did some digging into our internal docs, and for multi-code-lang pages, it looks like the possibilities for tab names are limited. It looks like if you rename this new file from java_servlet.md
to java.md
, it should fix it, and you should still be able to keep Java Servlet
as the page title. This all works on my local build, but if you have anything you'd like to troubleshoot together, don't hesitate to let me know!
content/en/real_user_monitoring/browser/setup/server/java_servlet.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/browser/setup/server/java_servlet.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/browser/setup/server/java_servlet.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/browser/setup/server/java_servlet.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/browser/setup/server/java_servlet.md
Outdated
Show resolved
Hide resolved
If you don't see the RUM JavaScript tag injected, try the following steps: | ||
|
||
1. **Check server logs** for any error messages related to RUM Auto-Instrumentation | ||
2. **Verify configuration** - ensure all required environment variables are set: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where should users first learn about these variables? If they should be preset in another step, that's fine - just want to make sure that they don't first see them in a troubleshooting section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated to the following, but let me know if you have better ideas
2. **Verify configuration** - ensure all required environment variables are set: | |
2. **Verify configuration** - ensure all required environment variables defined at the configuration step are set: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I wouldn't be sure which configuration step this would be referring to, because this guide doesn't include one?
Thanks for noticing this! I updated the filename and it does seem to work fine now. |
Awesome! Do you need to push this change? I'm still seeing the old filename 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, Rosa! I see what you mean now about your wording suggestion about the "configuration step" now 🙂 Just one line that snuck in there to take out in addition to that updated wording, and then we're good to go! Thanks again for your patience on this review!
Co-authored-by: Janine Chan <[email protected]>
* [DOCS-11542] Java servlet support RUM * add logo to partial * remove config * Apply suggestions from code review Co-authored-by: Janine Chan <[email protected]> * push changes * Update content/en/real_user_monitoring/browser/setup/server/java.md Co-authored-by: Janine Chan <[email protected]> * update link --------- Co-authored-by: Janine Chan <[email protected]>
What does this PR do? What is the motivation?
Adds a new page about how to auto-instrument RUM on java servlet-based web applications.
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>
convention and include the forward slash (/
). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes